Add deprecation notice on metrics port in runner and datastore #1886
+35
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Etai Lev Ran <[email protected]>
k8s-ci-robot
added
the
kind/deprecation
✅ Deploy Preview for gateway-api-inference-extension ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: elevran The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
size/M
Comment on lines
+135
to
+137
| modelServerMetricsPort = flag.Int("model-server-metrics-port", 0, "[DEPRECATED] Port to scrape metrics from pods. "+ | ||
| "Default value will be set to the InferencePool.Spec.TargetPorts[0].Number if not set."+ | ||
| "[DEPRECATED] This option will be removed in the next release.") |
Contributor
There was a problem hiding this comment.
can we put the [DEPRECATED] note only once?
Suggested change
| modelServerMetricsPort = flag.Int("model-server-metrics-port", 0, "[DEPRECATED] Port to scrape metrics from pods. "+ | |
| "Default value will be set to the InferencePool.Spec.TargetPorts[0].Number if not set."+ | |
| "[DEPRECATED] This option will be removed in the next release.") | |
| modelServerMetricsPort = flag.Int("model-server-metrics-port", 0, "[DEPRECATED] Port to scrape metrics from pods. "+ | |
| "Default value will be set to the InferencePool.Spec.TargetPorts[0].Number if not set."+ | |
| "This option will be removed in the next release.") |
Comment on lines
+473
to
+498
| func (r *Runner) deprecatedFlagsHandler(logger logr.Logger) error { | ||
| deprecated := map[string]string{ // Map of deprecated flags: key = flag name, value = replacement (empty if none) | ||
| "model-server-metrics-port": "", | ||
| } | ||
|
|
||
| var usedDeprecated []string // Track which deprecated flags were explicitly set | ||
| flag.Visit(func(f *flag.Flag) { | ||
| if _, ok := deprecated[f.Name]; ok { | ||
| usedDeprecated = append(usedDeprecated, f.Name) | ||
| } | ||
| }) | ||
|
|
||
| if len(usedDeprecated) > 0 { // report on deprecated flags used | ||
| for _, option := range usedDeprecated { | ||
| if replacement := deprecated[option]; replacement != "" { | ||
| logger.Info("deprecated option will be removed in the next release", | ||
| "option", option, "replacement", replacement) | ||
| } else { | ||
| logger.Info("deprecated option will be removed in the next release. No replacement available.", | ||
| "option", option) | ||
| } | ||
| } | ||
| return errors.New("deprecated options used" + fmt.Sprintf("%+v", usedDeprecated)) | ||
| } | ||
| return nil | ||
| } |
Contributor
There was a problem hiding this comment.
this function can be simplified to a 5 liner.
few points:
- as for now, we have no depracated flag that is replaced by a different flag. so the replacement part seems redundant.
- no need to use map for deprecated (can be a set or just a const as long as this is a single string).
- no need to run flag.Visit and then iterating over it again. while we're at the flag.Visit, we can check - if the depracated flag is used, log the deprecation notice.
- no need to return error (which is later ignored anyway).
k8s-ci-robot
added
the
needs-rebase
Contributor
|
PR needs rebase. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind deprecation
What this PR does / why we need it:
Defining a metric port via CLI conflicts with use of multiport inference pool and/or changes to inference-pool at runtime (see #1396 and #1398).
Which issue(s) this PR fixes:
Fixes #1398
Fixes #1396
Does this PR introduce a user-facing change?: